Skip to main content

DescribeCriteria

Description

call DescribeCriteria to obtain fuzzy matching query conditions for asset attributes that can be displayed when querying assets.

Request Method

POST

Request Path

/apsara/route/Sas/DescribeCriteria

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
regionIdBODYstringYesNo sample value for this parameter.region id
MachineTypesBODYstringNoecsthe asset type of the query. ecs : Indicates the filter criteria for querying all ECS servers. cloud_product : indicates the filter criteria for querying all other cloud products.
ValueBODYstringNoxxxthe incoming value to obtain fuzzy matching filter.
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
CriteriaListarrayNo sample value for this parameter.list of attribute criteria for asset query.
Typestringinputthe type of query condition. input: input item. Manual input is required. select: select item. You need to select from the drop-down box.
RequestIdstring3F6E4741-6CE6-47CA-80E8-CF5CB145DBE2request ID of the result.
ValuesstringNO,YES,UNKNOWNthe value of the selection item when the query condition type is the selection item. when the query condition is the input item, the return value of this parameter is empty.
NamestringriskStatusthe asset attribute name corresponding to this query condition.

Example

Successful Response example

{
"CriteriaList":"",
"Type":"input",
"RequestId":"3F6E4741-6CE6-47CA-80E8-CF5CB145DBE2",
"Values":"NO,
YES,
UNKNOWN",
"Name":"riskStatus"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}